Vcenter Vm Hardware Ethernet BackingSpec

The Vcenter Vm Hardware Ethernet BackingSpec schema provides a specification of the physical resource that backs a virtual Ethernet adapter.

JSON Example

{
    "type": "string",
    "network": "string",
    "distributed_port": "string"
}

string

type

Required

Backing type for the virtual Ethernet adapter.

For more information see: Vcenter Vm Hardware Ethernet BackingType.

string

network

Optional

Identifier of the network that backs the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is one of Vcenter Vm Hardware Ethernet BackingType.STANDARD_PORTGROUP, Vcenter Vm Hardware Ethernet BackingType.DISTRIBUTED_PORTGROUP, or Vcenter Vm Hardware Ethernet BackingType.OPAQUE_NETWORK.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network.

string

distributed_port

Optional

Key of the distributed virtual port that backs the virtual Ethernet adapter. Depending on the type of the Portgroup, the port may be specified using this field. If the portgroup type is early-binding (also known as static), a port is assigned when the Ethernet adapter is configured to use the port. The port may be either automatically or specifically assigned based on the value of this property. If the portgroup type is ephemeral, the port is created and assigned to a virtual machine when it is powered on and the Ethernet adapter is connected. This property cannot be specified as no free ports exist before use.

May be used to specify a port when the network specified on the network property is a static or early binding distributed portgroup. If missing or null, the port will be automatically assigned to the Ethernet adapter based on the policy embodied by the portgroup type.